<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpPDB: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="GimpPlugIn.html" title="GimpPlugIn">
<link rel="next" href="GimpProcedure.html" title="GimpProcedure">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpPDB.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpPDB.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpPlugIn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpProcedure.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpPDB"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpPDB.top_of_page"></a>GimpPDB</span></h2>
<p>GimpPDB — Functions for querying and changing procedural
database (PDB) entries.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpPDB.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-procedure-exists" title="gimp_pdb_procedure_exists ()">gimp_pdb_procedure_exists</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="returnvalue">GimpProcedure</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-lookup-procedure" title="gimp_pdb_lookup_procedure ()">gimp_pdb_lookup_procedure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-run-procedure" title="gimp_pdb_run_procedure ()">gimp_pdb_run_procedure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-run-procedure-valist" title="gimp_pdb_run_procedure_valist ()">gimp_pdb_run_procedure_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-run-procedure-array" title="gimp_pdb_run_procedure_array ()">gimp_pdb_run_procedure_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-run-procedure-argv" title="gimp_pdb_run_procedure_argv ()">gimp_pdb_run_procedure_argv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-temp-procedure-name" title="gimp_pdb_temp_procedure_name ()">gimp_pdb_temp_procedure_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-dump-to-file" title="gimp_pdb_dump_to_file ()">gimp_pdb_dump_to_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-query-procedures" title="gimp_pdb_query_procedures ()">gimp_pdb_query_procedures</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-get-last-error" title="gimp_pdb_get_last_error ()">gimp_pdb_get_last_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/libgimpbase3-gimpbaseenums.html#GimpPDBStatusType"><span class="returnvalue">GimpPDBStatusType</span></a>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-get-last-status" title="gimp_pdb_get_last_status ()">gimp_pdb_get_last_status</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-get-data" title="gimp_pdb_get_data ()">gimp_pdb_get_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-get-data-size" title="gimp_pdb_get_data_size ()">gimp_pdb_get_data_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpPDB.html#gimp-pdb-set-data" title="gimp_pdb_set_data ()">gimp_pdb_set_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpPDB.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GimpPDB
</pre>
</div>
<div class="refsect1">
<a name="GimpPDB.description"></a><h2>Description</h2>
<p>Functions for querying and changing procedural database (PDB)
entries.</p>
</div>
<div class="refsect1">
<a name="GimpPDB.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-pdb-procedure-exists"></a><h3>gimp_pdb_procedure_exists ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pdb_procedure_exists (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>);</pre>
<p>This function checks if a procedure exists in the procedural
database.</p>
<p>Return: <code class="literal">TRUE</code> if the procedure exists, <code class="literal">FALSE</code> otherwise.</p>
<div class="refsect3">
<a name="gimp-pdb-procedure-exists.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>A procedure name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-lookup-procedure"></a><h3>gimp_pdb_lookup_procedure ()</h3>
<pre class="programlisting"><a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="returnvalue">GimpProcedure</span></a> *
gimp_pdb_lookup_procedure (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>);</pre>
<p>This function returns the <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a> which is registered
with <em class="parameter"><code>procedure_name</code></em>
 if it exists, or returns <code class="literal">NULL</code> otherwise.</p>
<p>The returned <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a> is owned by <em class="parameter"><code>pdb</code></em>
 and must not be
modified.</p>
<p>Return: (nullable) (transfer none): A <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a>, or <code class="literal">NULL</code>.</p>
<div class="refsect3">
<a name="gimp-pdb-lookup-procedure.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>A procedure name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-run-procedure"></a><h3>gimp_pdb_run_procedure ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_pdb_run_procedure (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
                        <em class="parameter"><code><span class="type">GType</span> first_type</code></em>,
                        <em class="parameter"><code>...</code></em>);</pre>
<p>Runs the procedure named <em class="parameter"><code>procedure_name</code></em>
 with arguments given as
list of (<span class="type">GType</span>, value) pairs, terminated by <span class="type">G_TYPE_NONE</span>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="gimp-pdb-run-procedure.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>the procedure registered name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_type</p></td>
<td class="parameter_description"><p>the <span class="type">GType</span> of the first argument, or <span class="type">G_TYPE_NONE</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the call arguments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-run-procedure.returns"></a><h4>Returns</h4>
<p>the return values for the procedure call. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-run-procedure-valist"></a><h3>gimp_pdb_run_procedure_valist ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_pdb_run_procedure_valist (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                               <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
                               <em class="parameter"><code><span class="type">GType</span> first_type</code></em>,
                               <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<p>Runs the procedure named <em class="parameter"><code>procedure_name</code></em>
 with <em class="parameter"><code>args</code></em>
 given in the
order as passed to <a class="link" href="GimpPDB.html#gimp-pdb-run-procedure" title="gimp_pdb_run_procedure ()"><code class="function">gimp_pdb_run_procedure()</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-valist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>the procedure registered name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_type</p></td>
<td class="parameter_description"><p>the <span class="type">GType</span> of the first argument, or <span class="type">G_TYPE_NONE</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>the call arguments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-valist.returns"></a><h4>Returns</h4>
<p>the return values for the procedure call. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-run-procedure-array"></a><h3>gimp_pdb_run_procedure_array ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_pdb_run_procedure_array (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                              <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
                              <em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="type">GimpValueArray</span></a> *arguments</code></em>);</pre>
<p>Runs the procedure named <em class="parameter"><code>procedure_name</code></em>
 with <em class="parameter"><code>arguments</code></em>
.</p>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-array.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>the procedure registered name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arguments</p></td>
<td class="parameter_description"><p>the call arguments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-array.returns"></a><h4>Returns</h4>
<p>the return values for the procedure call. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-run-procedure-argv"></a><h3>gimp_pdb_run_procedure_argv ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
gimp_pdb_run_procedure_argv (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                             <em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
                             <em class="parameter"><code>const <span class="type">GValue</span> *arguments</code></em>,
                             <em class="parameter"><code><span class="type">gint</span> n_arguments</code></em>);</pre>
<p>Runs the procedure named <em class="parameter"><code>procedure_name</code></em>
 with <em class="parameter"><code>arguments</code></em>
.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gimp_pdb_run_procedure]</span></p>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-argv.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>procedure_name</p></td>
<td class="parameter_description"><p>the procedure registered name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arguments</p></td>
<td class="parameter_description"><p>the call arguments. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_arguments]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_arguments</p></td>
<td class="parameter_description"><p>the number of arguments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-run-procedure-argv.returns"></a><h4>Returns</h4>
<p>the return values for the procedure call. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-temp-procedure-name"></a><h3>gimp_pdb_temp_procedure_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_pdb_temp_procedure_name (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>);</pre>
<p>Generates a unique temporary PDB name.</p>
<p>This function generates a temporary PDB entry name that is
guaranteed to be unique.</p>
<div class="refsect3">
<a name="gimp-pdb-temp-procedure-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-temp-procedure-name.returns"></a><h4>Returns</h4>
<p>A unique temporary name for a temporary
PDB entry. The returned value must be freed with
<code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-dump-to-file"></a><h3>gimp_pdb_dump_to_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pdb_dump_to_file (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                       <em class="parameter"><code><span class="type">GFile</span> *file</code></em>);</pre>
<p>Dumps the current contents of the procedural database</p>
<p>This procedure dumps the contents of the procedural database to the
specified <em class="parameter"><code>file</code></em>
. The file will contain all of the information
provided for each registered procedure.</p>
<div class="refsect3">
<a name="gimp-pdb-dump-to-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>The dump file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-dump-to-file.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-query-procedures"></a><h3>gimp_pdb_query_procedures ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
gimp_pdb_query_procedures (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *blurb</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *help</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *authors</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *proc_type</code></em>,
                           <em class="parameter"><code><span class="type">gint</span> *num_matches</code></em>);</pre>
<p>Queries the procedural database for its contents using regular
expression matching.</p>
<p>This function queries the contents of the procedural database. It
is supplied with eight arguments matching procedures on</p>
<p>{ name, blurb, help, help-id, authors, copyright, date, procedure type}.</p>
<p>This is accomplished using regular expression matching. For
instance, to find all procedures with "jpeg" listed in the blurb,
all seven arguments can be supplied as ".*", except for the second,
which can be supplied as ".*jpeg.*". There are two return arguments
for this procedure. The first is the number of procedures matching
the query. The second is a concatenated list of procedure names
corresponding to those matching the query. If no matching entries
are found, then the returned string is NULL and the number of
entries is 0.</p>
<div class="refsect3">
<a name="gimp-pdb-query-procedures.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The regex for procedure name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>blurb</p></td>
<td class="parameter_description"><p>The regex for procedure blurb.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help</p></td>
<td class="parameter_description"><p>The regex for procedure help.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_id</p></td>
<td class="parameter_description"><p>The regex for procedure help-id.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>authors</p></td>
<td class="parameter_description"><p>The regex for procedure authors.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>copyright</p></td>
<td class="parameter_description"><p>The regex for procedure copyright.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>date</p></td>
<td class="parameter_description"><p>The regex for procedure date.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proc_type</p></td>
<td class="parameter_description"><p>The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension', 'Temporary Procedure' }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_matches</p></td>
<td class="parameter_description"><p>The number of matching procedures. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-query-procedures.returns"></a><h4>Returns</h4>
<p>The list
of procedure names. Free with <code class="function">g_strfreev()</code>. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_matches][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-get-last-error"></a><h3>gimp_pdb_get_last_error ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_pdb_get_last_error (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>);</pre>
<p>Retrieves the error message from the last procedure call.</p>
<p>If a procedure call fails, then it might pass an error message with
the return values. Plug-ins that are using the libgimp C wrappers
don't access the procedure return values directly. Thus <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a>
stores the error message and makes it available with this
function. The next procedure call unsets the error message again.</p>
<p>The returned string is owned by <em class="parameter"><code>pdb</code></em>
 and must not be freed or
modified.</p>
<div class="refsect3">
<a name="gimp-pdb-get-last-error.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-get-last-error.returns"></a><h4>Returns</h4>
<p> the error message</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-get-last-status"></a><h3>gimp_pdb_get_last_status ()</h3>
<pre class="programlisting"><a href="../html/libgimpbase3-gimpbaseenums.html#GimpPDBStatusType"><span class="returnvalue">GimpPDBStatusType</span></a>
gimp_pdb_get_last_status (<em class="parameter"><code><a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a> *pdb</code></em>);</pre>
<p>Retrieves the status from the last procedure call.</p>
<div class="refsect3">
<a name="gimp-pdb-get-last-status.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pdb</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpPDB.html" title="GimpPDB"><span class="type">GimpPDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-get-last-status.returns"></a><h4>Returns</h4>
<p> the <a href="../html/libgimpbase3-gimpbaseenums.html#GimpPDBStatusType"><span class="type">GimpPDBStatusType</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-get-data"></a><h3>gimp_pdb_get_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pdb_get_data (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>,
                   <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>Returns data associated with the specified identifier.</p>
<p>This procedure returns any data which may have been associated with
the specified identifier. The data is copied into the given memory
location.</p>
<div class="refsect3">
<a name="gimp-pdb-get-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>identifier</p></td>
<td class="parameter_description"><p>The identifier associated with data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A byte array containing data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-get-data.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE if no data has been associated with
the identifier</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-get-data-size"></a><h3>gimp_pdb_get_data_size ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_pdb_get_data_size (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>);</pre>
<p>Returns size of data associated with the specified identifier.</p>
<p>This procedure returns the size of any data which may have been
associated with the specified identifier. If no data has been
associated with the identifier, an error is returned.</p>
<div class="refsect3">
<a name="gimp-pdb-get-data-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>identifier</p></td>
<td class="parameter_description"><p>The identifier associated with data.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-get-data-size.returns"></a><h4>Returns</h4>
<p> The number of bytes in the data.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pdb-set-data"></a><h3>gimp_pdb_set_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pdb_set_data (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>,
                   <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>,
                   <em class="parameter"><code><span class="type">guint32</span> bytes</code></em>);</pre>
<p>Associates the specified identifier with the supplied data.</p>
<p>This procedure associates the supplied data with the provided
identifier. The data may be subsequently retrieved by a call to
'procedural-db-get-data'.</p>
<div class="refsect3">
<a name="gimp-pdb-set-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>identifier</p></td>
<td class="parameter_description"><p>The identifier associated with data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A byte array containing data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bytes</p></td>
<td class="parameter_description"><p>The number of bytes in the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pdb-set-data.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>